<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/util.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">util.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__core_2src_2ipc_2util_2util_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="detail_2util__fwd_8hpp.html">ipc/util/detail/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="native__handle_8hpp.html">ipc/util/native_handle.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;flow/common.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;sys/stat.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">// Initializations.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a5664539b3d75d6d10cdfebf6eac5382d">   30</a></span><span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a9571de958538d7a4a8649bbfecfac0b9">Open_or_create</a> <a class="code hl_variable" href="namespaceipc_1_1util.html#a5664539b3d75d6d10cdfebf6eac5382d">OPEN_OR_CREATE</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a6a3a6ec85242d073df96978c63464078">   31</a></span><span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a3e03491b5b2b5fac26551a220946d6e5">Open_only</a> <a class="code hl_variable" href="namespaceipc_1_1util.html#a6a3a6ec85242d073df96978c63464078">OPEN_ONLY</a>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#ad1ca1cab79a35e1eb1c47037a0973cd8">   32</a></span><span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a9d84c2bab504e6de32b20c77ca9723a2">Create_only</a> <a class="code hl_variable" href="namespaceipc_1_1util.html#ad1ca1cab79a35e1eb1c47037a0973cd8">CREATE_ONLY</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#aca6ca223759ca3e11d5834a323454afa">   33</a></span><span class="keyword">const</span> std::string <a class="code hl_variable" href="namespaceipc_1_1util.html#aca6ca223759ca3e11d5834a323454afa">EMPTY_STRING</a>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#abda2ce5bcdbc26ca63d667b87818439c">   37</a></span><a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a> <a class="code hl_function" href="namespaceipc_1_1util.html#abda2ce5bcdbc26ca63d667b87818439c">shared_resource_permissions</a>(<a class="code hl_enumeration" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705d">Permissions_level</a> permissions_lvl)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>{</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>  <span class="keyword">const</span> <span class="keyword">auto</span> raw_lvl = size_t(permissions_lvl);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  assert((raw_lvl &lt; <span class="keywordtype">size_t</span>(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>))</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>         &amp;&amp; <span class="stringliteral">&quot;Seems the sentinel enum value was specified, or there is an internal maintenance bug.&quot;</span>);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keywordflow">return</span> <a class="code hl_variable" href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a>[raw_lvl];</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>}</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">   46</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">set_resource_permissions</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> fs::path&amp; path,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>                              <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>&amp; perms, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>{</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>  using ::open;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>  using ::close;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  <span class="comment">// using ::O_PATH; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>  <span class="comment">// using ::errno; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>           { <a class="code hl_function" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">set_resource_permissions</a>(logger_ptr, path, perms, actual_err_code); },</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>         err_code, <span class="stringliteral">&quot;util::set_resource_permissions(1)&quot;</span>))</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>  {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>  }</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_UTIL);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>  <span class="comment">/* We can either reuse the handle-based overload, or we can do fs::permissions.  The latter is perhaps more</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">   * portable and certainly a few lines easier and logically simpler.  Nevertheless I (ygoldfel) chose the former,</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">   * and that is for consistency (and not just in a cosmetic sense; I&#39;d like both routines to work and fail in</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">   * similar ways with fewer degrees of freedom on how to differ based on some 3rd-party developer&#39;s whims).</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   * (@todo It is certainly arguable.)  Thing is, there&#39;s an `fs` way of doing fs::permissions(path), but</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * there&#39;s no fs::permissions(&lt;FD&gt;).  So we&#39;d have to use a native call for the latter but `fs` for the other</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * former?  Nah.  Let&#39;s just do it native all the way but build one on top of the other.  Also this repeats</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   * the technique in session::ensure_resource_owner_is_app(). */</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>  <span class="keywordtype">int</span> native_handle = open(path.c_str(), O_RDONLY); <span class="comment">// Read-only is sufficient for ::fchmod().</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="keywordflow">if</span> (native_handle == -1)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>  {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>    *err_code = <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Tried to set permissions of resource at [&quot;</span> &lt;&lt; path &lt;&lt; <span class="stringliteral">&quot;] but while obtaining info-only handle &quot;</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>                     <span class="stringliteral">&quot;encountered error [&quot;</span> &lt;&lt; *err_code &lt;&lt; <span class="stringliteral">&quot;] [&quot;</span> &lt;&lt; err_code-&gt;message() &lt;&lt; <span class="stringliteral">&quot;]; unable to proceed.&quot;</span>);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>  }</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> handle(native_handle);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>  <span class="comment">// For nicer messaging add some more logging on error.  A little code duplication, but it&#39;s OK.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>  <a class="code hl_function" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">set_resource_permissions</a>(logger_ptr, handle, perms, err_code);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>  <span class="keywordflow">if</span> (*err_code)</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>  {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Tried to set permissions of resource at [&quot;</span> &lt;&lt; path &lt;&lt; <span class="stringliteral">&quot;], upon successfully opening probe-only &quot;</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>                     <span class="stringliteral">&quot;descriptor/handle, but this resulted in error; see preceding WARNING referencing all &quot;</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>                     <span class="stringliteral">&quot;other details.&quot;</span>);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>  }</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>  close(native_handle);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>} <span class="comment">// set_resource_permissions(1)</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#af8b2f5a0cd9fe9db4511c9a3e685b6ae">   98</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">set_resource_permissions</a>(flow::log::Logger* logger_ptr, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> handle,</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>                              <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>&amp; perms, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>{</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  using ::fchmod;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>  <span class="comment">// using ::errno; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>           { <a class="code hl_function" href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">set_resource_permissions</a>(logger_ptr, handle, perms, actual_err_code); },</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>         err_code, <span class="stringliteral">&quot;util::set_resource_permissions(2)&quot;</span>))</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>  {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>  }</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>  assert((!handle.<a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">null</a>()) &amp;&amp; <span class="stringliteral">&quot;Disallowed per contract.&quot;</span>);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_UTIL);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>  <span class="comment">// There&#39;s no Boost.filesystem or STL way to set mode, that I know of (via FD); so use POSIX-y thing.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>  <span class="keyword">const</span> <span class="keyword">auto</span> rc = fchmod(handle.<a class="code hl_variable" href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">m_native_handle</a>, perms.get_permissions());</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>  <span class="keywordflow">if</span> (rc == -1)</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>  {</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>    *err_code = <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Tried to set permissions of resources via descriptor/handle [&quot;</span> &lt;&lt; handle &lt;&lt; <span class="stringliteral">&quot;] but encountered &quot;</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>                     <span class="stringliteral">&quot;error [&quot;</span> &lt;&lt; *err_code &lt;&lt; <span class="stringliteral">&quot;] [&quot;</span> &lt;&lt; err_code-&gt;message() &lt;&lt; <span class="stringliteral">&quot;]; unable to check.&quot;</span>);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>  }</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>  {</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>    err_code-&gt;clear();</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>  }</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>  <span class="comment">// As promised don&#39;t log anything else (not even TRACE) and leave that to the caller if desired.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>} <span class="comment">// set_resource_permissions(2)</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a924cd56daf7eeaa0b07edb352367f9ec">  134</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a924cd56daf7eeaa0b07edb352367f9ec">process_running</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">process_id_t</a> process_id)</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>{</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  using ::kill;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>  <span class="comment">// using ::errno; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>  <span class="comment">// The below, down to the impl, is described in the doc header.  Note these are POSIX semantics.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="preprocessor">#ifndef FLOW_OS_LINUX</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>  <span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;Using POSIX ::kill(pid, 0) semantics to check whether process running.  &quot;</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>                         <span class="stringliteral">&quot;Have not coded Windows equivalent yet.  Should work in non-Linux POSIX OS but &quot;</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>                         <span class="stringliteral">&quot;must be checked/tested.&quot;</span>);</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  <span class="keywordflow">if</span> (kill(process_id, 0) == 0)</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>  {</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>    <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>  }</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  assert((<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category()) == boost::system::errc::no_such_process)</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>         &amp;&amp; <span class="stringliteral">&quot;The fake signal zero is valid and is not actually sent so no permission problem possible; hence &quot;</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>              <span class="stringliteral">&quot;ESRCH or equivalent must be the only possible error.&quot;</span>);</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>} <span class="comment">// process_running()</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a2bb38cee29dacbe56de5182221b45941">  158</a></span><span class="keyword">const</span> uint8_t* <a class="code hl_function" href="namespaceipc_1_1util.html#a2bb38cee29dacbe56de5182221b45941">blob_data</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">Blob_const</a>&amp; blob)</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>{</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keyword">const </span>uint8_t*<span class="keyword">&gt;</span>(blob.data());</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>}</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#af38a66554a822a470667967c56083e3b">  163</a></span>uint8_t* <a class="code hl_function" href="namespaceipc_1_1util.html#a2bb38cee29dacbe56de5182221b45941">blob_data</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">Blob_mutable</a>&amp; blob)</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>{</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>uint8_t*<span class="keyword">&gt;</span>(blob.data());</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>}</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span> </div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="ttc" id="adetail_2util__fwd_8hpp_html"><div class="ttname"><a href="detail_2util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a0c44028a45451ebf21f6af8e806b2682"><div class="ttname"><a href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">ipc::util::process_id_t</a></div><div class="ttdeci">::pid_t process_id_t</div><div class="ttdoc">Syntactic-sugary type for POSIX process ID (integer).</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00143">util_fwd.hpp:143</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1b398ae730d1e6040687cb2397115152"><div class="ttname"><a href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">ipc::util::Permissions</a></div><div class="ttdeci">bipc::permissions Permissions</div><div class="ttdoc">Short-hand for Unix (POSIX) permissions class.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00161">util_fwd.hpp:161</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a2bb38cee29dacbe56de5182221b45941"><div class="ttname"><a href="namespaceipc_1_1util.html#a2bb38cee29dacbe56de5182221b45941">ipc::util::blob_data</a></div><div class="ttdeci">const uint8_t * blob_data(const Blob_const &amp;blob)</div><div class="ttdoc">Syntactic-sugary helper that returns pointer to first byte in an immutable buffer,...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00158">util.cpp:158</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a2ec0bfdddb41a1ef0403e4bb8967705d"><div class="ttname"><a href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705d">ipc::util::Permissions_level</a></div><div class="ttdeci">Permissions_level</div><div class="ttdoc">Simple specifier of desired access permissions, usually but not necessarily translated into a Permiss...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00093">util_fwd.hpp:94</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf"><div class="ttname"><a href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">ipc::util::Permissions_level::S_END_SENTINEL</a></div><div class="ttdeci">@ S_END_SENTINEL</div><div class="ttdoc">Sentinel: not a valid value. May be used to, e.g., size an array&lt;&gt; mapping from Permissions_level.</div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a3e03491b5b2b5fac26551a220946d6e5"><div class="ttname"><a href="namespaceipc_1_1util.html#a3e03491b5b2b5fac26551a220946d6e5">ipc::util::Open_only</a></div><div class="ttdeci">bipc::open_only_t Open_only</div><div class="ttdoc">Tag type indicating an ideally-atomic open-if-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00155">util_fwd.hpp:155</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5664539b3d75d6d10cdfebf6eac5382d"><div class="ttname"><a href="namespaceipc_1_1util.html#a5664539b3d75d6d10cdfebf6eac5382d">ipc::util::OPEN_OR_CREATE</a></div><div class="ttdeci">const Open_or_create OPEN_OR_CREATE</div><div class="ttdoc">Tag value indicating an open-if-exists-else-create operation.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00030">util.cpp:30</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5716a13eb4de32e516ca257e025d8c20"><div class="ttname"><a href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">ipc::util::SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a></div><div class="ttdeci">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt; SHARED_RESOURCE_PERMISSIONS_LVL_MAP</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00033">util.cpp:34</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6a3a6ec85242d073df96978c63464078"><div class="ttname"><a href="namespaceipc_1_1util.html#a6a3a6ec85242d073df96978c63464078">ipc::util::OPEN_ONLY</a></div><div class="ttdeci">const Open_only OPEN_ONLY</div><div class="ttdoc">Tag value indicating an atomic open-if-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00031">util.cpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a924cd56daf7eeaa0b07edb352367f9ec"><div class="ttname"><a href="namespaceipc_1_1util.html#a924cd56daf7eeaa0b07edb352367f9ec">ipc::util::process_running</a></div><div class="ttdeci">bool process_running(process_id_t process_id)</div><div class="ttdoc">Returns true if and only if the given process (by PID) is reported as running by the OS.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00134">util.cpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a9571de958538d7a4a8649bbfecfac0b9"><div class="ttname"><a href="namespaceipc_1_1util.html#a9571de958538d7a4a8649bbfecfac0b9">ipc::util::Open_or_create</a></div><div class="ttdeci">bipc::open_or_create_t Open_or_create</div><div class="ttdoc">Tag type indicating an atomic open-if-exists-else-create operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00152">util_fwd.hpp:152</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a9d84c2bab504e6de32b20c77ca9723a2"><div class="ttname"><a href="namespaceipc_1_1util.html#a9d84c2bab504e6de32b20c77ca9723a2">ipc::util::Create_only</a></div><div class="ttdeci">bipc::create_only_t Create_only</div><div class="ttdoc">Tag type indicating a create-unless-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00158">util_fwd.hpp:158</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_abbba79fcaee378f433e7ce3093e5c435"><div class="ttname"><a href="namespaceipc_1_1util.html#abbba79fcaee378f433e7ce3093e5c435">ipc::util::set_resource_permissions</a></div><div class="ttdeci">void set_resource_permissions(flow::log::Logger *logger_ptr, const fs::path &amp;path, const Permissions &amp;perms, Error_code *err_code)</div><div class="ttdoc">Utility that sets the permissions of the given resource (at the supplied file system path) to specifi...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00046">util.cpp:46</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_abda2ce5bcdbc26ca63d667b87818439c"><div class="ttname"><a href="namespaceipc_1_1util.html#abda2ce5bcdbc26ca63d667b87818439c">ipc::util::shared_resource_permissions</a></div><div class="ttdeci">Permissions shared_resource_permissions(Permissions_level permissions_lvl)</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00037">util.cpp:37</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aca6ca223759ca3e11d5834a323454afa"><div class="ttname"><a href="namespaceipc_1_1util.html#aca6ca223759ca3e11d5834a323454afa">ipc::util::EMPTY_STRING</a></div><div class="ttdeci">const std::string EMPTY_STRING</div><div class="ttdoc">A (default-cted) string. May be useful for functions returning const std::string&amp;.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00033">util.cpp:33</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ad1ca1cab79a35e1eb1c47037a0973cd8"><div class="ttname"><a href="namespaceipc_1_1util.html#ad1ca1cab79a35e1eb1c47037a0973cd8">ipc::util::CREATE_ONLY</a></div><div class="ttdeci">const Create_only CREATE_ONLY</div><div class="ttdoc">Tag value indicating an atomic create-unless-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00032">util.cpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anative__handle_8hpp_html"><div class="ttname"><a href="native__handle_8hpp.html">native_handle.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a11bd62ce0a7bef4bdfe666201c26d4dc"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">ipc::util::Native_handle::null</a></div><div class="ttdeci">bool null() const</div><div class="ttdoc">Returns true if and only if m_native_handle equals S_NULL_HANDLE.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00061">native_handle.cpp:61</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_ab2f496740139c5752a25a30cf3325d86"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">ipc::util::Native_handle::m_native_handle</a></div><div class="ttdeci">handle_t m_native_handle</div><div class="ttdoc">The native handle (possibly equal to S_NULL_HANDLE), the exact payload of this Native_handle.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00085">native_handle.hpp:85</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
